Influx Cloud API Service (2.0.1)

Download OpenAPI specification:Download

The InfluxDB v2 API provides a programmatic interface for all interactions with InfluxDB. Access the InfluxDB API using the /api/v2/ endpoint.

Authentication

TokenAuth

InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.

Include your API token in an Authentication: Token YOUR_API_TOKEN HTTP header with each request.

Example

curl https://us-east-1-1.aws.cloud2.influxdata.com/ --header "Authentication: Token YOUR_API_TOKEN"

For more information and examples, see the following:

Security Scheme Type	HTTP
HTTP Authorization Scheme	token

BasicAuth

Use Basic authentication with clients that support the InfluxDB 1.x convention of username and password (that don't support the Authorization: Token scheme):

username: InfluxDB Cloud username
password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

QuerystringAuth

Use InfluxDB 1.x API parameters to provide credentials through the query string.

Username and password schemes require the following credentials:

username: InfluxDB Cloud username
password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --data-urlencode "u=YOUR_USERNAME" --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type	API Key
Query parameter name:	u=&p=

Authentication

Use one of the following schemes to authenticate to the InfluxDB API:

Token authentication
Basic authentication
Querystring authentication

TokenAuth

InfluxDB API tokens ensure secure interaction between users and data. A token belongs to an organization and identifies InfluxDB permissions within the organization.

Include your API token in an Authentication: Token YOUR_API_TOKEN HTTP header with each request.

Example

curl https://us-east-1-1.aws.cloud2.influxdata.com/ --header "Authentication: Token YOUR_API_TOKEN"

For more information and examples, see the following:

Security Scheme Type	HTTP
HTTP Authorization Scheme	token

BasicAuth

Use Basic authentication with clients that support the InfluxDB 1.x convention of username and password (that don't support the Authorization: Token scheme):

username: InfluxDB Cloud username
password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --user "YOUR_USERNAME":"YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type	HTTP
HTTP Authorization Scheme	basic

QuerystringAuth

Use InfluxDB 1.x API parameters to provide credentials through the query string.

Username and password schemes require the following credentials:

username: InfluxDB Cloud username
password: InfluxDB Cloud API token

Example

curl --get "https://europe-west1-1.gcp.cloud2.influxdata.com/query" --data-urlencode "u=YOUR_USERNAME" --data-urlencode "p=YOUR_TOKEN_OR_PASSWORD"

For more information and examples, see how to authenticate with a username and password scheme.

Security Scheme Type	API Key
Query parameter name:	u=&p=

Write

Write time series data to buckets.

Write data

Writes data to a bucket.

To write data into InfluxDB, you need the following:

organization – See View organizations for instructions on viewing your organization ID.
bucket – See View buckets for instructions on viewing your bucket ID.
API token – See View tokens for instructions on viewing your API token.
InfluxDB URL – See InfluxDB URLs.
data in line protocol format.

For more information and examples, see Write data with the InfluxDB API.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org required	string The parameter value specifies the destination organization for writes. The database writes all points in the batch to this organization. If you provide both `orgID` and `org` parameters, `org` takes precedence.
orgID	string The parameter value specifies the ID of the destination organization for writes. If both `orgID` and `org` are specified, `org` takes precedence.
bucket required	string The destination bucket for writes.
precision	string (WritePrecision) Enum: "ms" "s" "us" "ns" The precision for the unix timestamps within the body line-protocol.

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Content-Encoding	string Default: identity Enum: "gzip" "identity" When present, the header value tells the database that compression is applied to the line protocol in the request body.
Content-Type	string Default: text/plain; charset=utf-8 Enum: "text/plain" "text/plain; charset=utf-8" "application/vnd.influx.arrow" The header value indicates the format of the data in the request body.
Content-Length	integer The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's `max body` configuration option, the server responds with status code `413`.
Accept	string Default: application/json Value: "application/json" The header value specifies the response format.

Request Body schema: text/plain

Data in line protocol format.

string <byte>

Responses

Response samples

400
401
404
413
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string",
"line": 0
}

Query

Retrieve data, analyze queries, and get query suggestions.

Generate an Abstract Syntax Tree (AST) from a query

Analyzes flux query and generates a query specification.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Content-Type	string Value: "application/json"

Request Body schema: application/json

Analyzed Flux query to generate abstract syntax tree.

query

required

string

Flux query script to be analyzed

Responses

Request samples

Payload

Content type

application/json

{"query": "string"
}

Response samples

200
default

Content type

application/json

{"ast": {"type": "string",
"path": "string",
"package": "string",
"files": [{"type": "string",
"name": "string",
"package": {"type": "string",
"name": {"type": "string",
"name": "string"
}
},
"imports": [{"type": "string",
"as": {"type": "string",
"name": "string"
},
"path": {"type": "string",
"value": "string"
}
}
],
"body": [{"type": "string",
"text": "string"
}
]
}
]
}
}

Retrieve query suggestions

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"funcs": [{"name": "string",
"params": {"property1": "string",
"property2": "string"
}
}
]
}

Retrieve query suggestions for a branching suggestion

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

name

required

string

The name of the branching suggestion.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"name": "string",
"params": {"property1": "string",
"property2": "string"
}
}

Analyze an InfluxQL or Flux query

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Content-Type	string Value: "application/json"

Request Body schema: application/json

Flux or InfluxQL query to analyze

	object (File) Represents a source from a single file
query required	string Query script to execute.
type	string Value: "flux" The type of query. Must be "flux".
	object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)
	object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
now	string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Payload

Content type

application/json

{"extern": {"type": "string",
"name": "string",
"package": {"type": "string",
"name": {"type": "string",
"name": "string"
}
},
"imports": [{"type": "string",
"as": {"type": "string",
"name": "string"
},
"path": {"type": "string",
"value": "string"
}
}
],
"body": [{"type": "string",
"text": "string"
}
]
},
"query": "string",
"type": "flux",
"params": { },
"dialect": {"header": true,
"delimiter": ",",
"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339"
},
"now": "2019-08-24T14:15:22Z"
}

Response samples

200
default

Content type

application/json

{"errors": [{"line": 0,
"column": 0,
"character": 0,
"message": "string"
}
]
}

Query data

Retrieves data from InfluxDB buckets.

To query data, you need the following:

organization – See View organizations for instructions on viewing your organization ID.
API token – See View tokens for instructions on viewing your API token.
InfluxDB URL – See InfluxDB URLs.
Flux or InfluxQL query.

For more information and examples, see Query with the InfluxDB API.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org	string Specifies the name of the organization executing the query. Takes either the ID or Name. If both `orgID` and `org` are specified, `org` takes precedence.
orgID	string Specifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence.

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Accept-Encoding	string Default: identity Enum: "gzip" "identity" The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
Content-Type	string Enum: "application/json" "application/vnd.flux"

Request Body schema:
application/json
application/json
application/vnd.flux

Flux query or specification to execute

One of

	object (File) Represents a source from a single file
query required	string Query script to execute.
type	string Value: "flux" The type of query. Must be "flux".
	object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)
	object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
now	string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Payload

Content type

Example

{"extern": {"type": "string",
"name": "string",
"package": {"type": "string",
"name": {"type": "string",
"name": "string"
}
},
"imports": [{"type": "string",
"as": {"type": "string",
"name": "string"
},
"path": {"type": "string",
"value": "string"
}
}
],
"body": [{"type": "string",
"text": "string"
}
]
},
"query": "string",
"type": "flux",
"params": { },
"dialect": {"header": true,
"delimiter": ",",
"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339"
},
"now": "2019-08-24T14:15:22Z"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Buckets

List all buckets

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
after	string The last resource ID from which to seek from (but not including). This is to be used instead of `offset`.
org	string The name of the organization.
orgID	string The organization ID.
name	string Only returns buckets with a specific name.
id	string Only returns buckets with a specific ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"buckets": [{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}
]
}

Create a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket to create

orgID required	string
name required	string
description	string
rp	string
required	Array of objects (RetentionRules) Rules to expire or retain data. No rules means data never expires.
schemaType	string (SchemaType) Enum: "implicit" "explicit"

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"rp": "string",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"schemaType": "implicit"
}

Response samples

201
422
default

Content type

application/json

{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Retrieve a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Update a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket update to apply

name	string
description	string
	Array of objects (PatchRetentionRules) Updates to rules to expire or retain data. No rules means no updates.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
]
}

Response samples

200
default

Content type

application/json

{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Delete a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The ID of the bucket to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID required	string The bucket ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all users with member privileges for a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
bucketID required	string The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
bucketID required	string The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Dashboards

Retrieve a Dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

query Parameters

include

string

Value: "properties"

Includes the cell view properties in the response if set to properties

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

Example

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Update a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Patching of a dashboard

name	string optional, when provided will replace the name
description	string optional, when provided will replace the description
	object (CellWithViewProperties)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"cells": {"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}
}

Response samples

200
404
default

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Delete a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Array ()

id	string
	object
x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>
viewID	string The reference to a view from the views API.

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
]

Response samples

201
404
default

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Create a dashboard cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Cell that will be added

name	string
x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>
usingView	string Makes a copy of the provided view.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"usingView": "string"
}

Response samples

201
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to update.
cellID required	string The ID of the cell to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"x": 0,
"y": 0,
"w": 0,
"h": 0
}

Response samples

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}

Delete a dashboard cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to delete.
cellID required	string The ID of the cell to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Retrieve the view for a cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The dashboard ID.
cellID required	string The cell ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "string"
},
"id": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Update the view for a cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to update.
cellID required	string The ID of the cell to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

name

required

string

required

LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Response samples

200
404
default

Content type

application/json

{"links": {"self": "string"
},
"id": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

List all labels for a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The dashboard ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all dashboard members

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
dashboardID required	string The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all dashboard owners

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
dashboardID required	string The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Create a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Dashboard to create

orgID required	string The ID of the organization that owns the dashboard.
name required	string The user-facing name of the dashboard.
description	string The user-facing description of the dashboard.

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string"
}

Response samples

201
default

Content type

application/json

Example

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

List all dashboards

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
descending	boolean Default: false
limit	integer [ -1 .. 100 ] Default: 20 The non-zero number of dashboards to return
owner	string A user identifier. Returns only dashboards where this user has the `owner` role.
sortBy	string Enum: "ID" "CreatedAt" "UpdatedAt" The column to sort by.
id	Array of strings A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used.
orgID	string The identifier of the organization.
org	string The name of the organization.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"dashboards": [{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}
]
}

Tasks

Retrieve a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}

Update a task

Update a task. This will cancel all queued runs.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task update to apply

status	string (TaskStatusType) Enum: "active" "inactive"
flux	string The Flux script to run for this task.
name	string Override the 'name' option in the flux script.
every	string Override the 'every' option in the flux script.
cron	string Override the 'cron' option in the flux script.
offset	string Override the 'offset' option in the flux script.
description	string An optional description of the task.

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"flux": "string",
"name": "string",
"every": "string",
"cron": "string",
"offset": "string",
"description": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}

Delete a task

Deletes a task and all associated records

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The ID of the task to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List runs for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The ID of the task to get runs for.

query Parameters

after	string Returns runs after a specific ID.
limit	integer [ 1 .. 500 ] Default: 100 The number of runs to return
afterTime	string <date-time> Filter runs to those scheduled after this time, RFC3339
beforeTime	string <date-time> Filter runs to those scheduled before this time, RFC3339

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"runs": [{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}
]
}

Manually start a task run, overriding the current schedule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

scheduledFor

string <date-time> Nullable

Time used for run's "now" option, RFC3339. Default is the server's now time.

Responses

Request samples

Payload

Content type

application/json

{"scheduledFor": "2019-08-24T14:15:22Z"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}

Retrieve a single run for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
runID required	string The run ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}

Cancel a running task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
runID required	string The run ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Retry a task run

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
runID required	string The run ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json; charset=utf-8

object

Responses

Request samples

Payload

Content type

application/json; charset=utf-8

{ }

Response samples

200
default

Content type

application/json

{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}

Retrieve all logs for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"events": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
]
}

Retrieve all logs for a run

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string ID of task to get logs for.
runID required	string ID of run to get logs for.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"events": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
]
}

List all labels for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
labelID required	string The label ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all task members

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
taskID required	string The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
taskID required	string The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all tasks

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

name	string Returns task with a specific name.
after	string Return tasks after a specified ID.
user	string Filter tasks to a specific user ID.
org	string Filter tasks to a specific organization name.
orgID	string Filter tasks to a specific organization ID.
status	string Enum: "active" "inactive" Filter tasks by a status--"inactive" or "active".
limit	integer [ -1 .. 500 ] Default: 100 The non-zero number of tasks to return
type	string Default: "" Enum: "basic" "system" Type of task, unset by default.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"tasks": [{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}
]
}

Create a new task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task to create

orgID	string The ID of the organization that owns this Task.
org	string The name of the organization that owns this Task.
status	string (TaskStatusType) Enum: "active" "inactive"
flux required	string The Flux script to run for this task.
description	string An optional description of the task.

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"org": "string",
"status": "active",
"flux": "string",
"description": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}

Authorizations

Create and manage API tokens. An authorization associates a list of permissions to an organization and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.

List all authorizations

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

userID	string Only show authorizations that belong to a user ID.
user	string Only show authorizations that belong to a user name.
orgID	string Only show authorizations that belong to an organization ID.
org	string Only show authorizations that belong to a organization name.
token	string Find a token by value.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"authorizations": [{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}
]
}

Create an authorization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Authorization to create

status	string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected.
description	string A description of the token.
orgID required	string ID of org that authorization is scoped to.
required	Array of objects (Permission) non-empty List of permissions for an auth. An auth must have at least one Permission.

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"description": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
]
}

Response samples

201
400
default

Content type

application/json

{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}

Retrieve an authorization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

authID

required

string

The identifier of the authorization to get.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}

Update authorization status

Update an authorization's status to active or inactive.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

authID

required

string

The identifier of the authorization to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

The updated Authorization object.

status	string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected.
description	string A description of the token.

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"description": "string"
}

Response samples

200
default

Content type

application/json

{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}

Delete an authorization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

authID

required

string

The identifier of the authorization to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Organizations

List all organizations

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
descending	boolean Default: false
org	string Filter organizations to a specific organization name.
orgID	string Filter organizations to a specific organization ID.
userID	string Filter organizations to a specific user ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"orgs": [{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}
]
}

Create an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization to create

name required	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}

Retrieve an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The ID of the organization to get.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}

Update an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The ID of the organization to get.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization update to apply

name	string New name to set on the organization
description	string New description to set on the organization

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}

Delete an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The ID of the organization to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all members of an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
orgID required	string The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
orgID required	string The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Users

Return the feature flags for the currently authenticated user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{ }

Retrieve the currently authenticated user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Update a password

Authorizations:

BasicAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password

required

string

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Update a password

Authorizations:

BasicAuth

path Parameters

userID

required

string

The user ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password

required

string

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all users

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}
]
}

Create a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to create

oauthID	string
name required	string
status	string Default: "active" Enum: "active" "inactive" If inactive the user is inactive.
role	string Enum: "owner" "member"
org_id	string

Responses

Request samples

Payload

Content type

application/json

{"oauthID": "string",
"name": "string",
"status": "active",
"role": "owner",
"org_id": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Retrieve a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID

required

string

The user ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Update a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID

required

string

The ID of the user to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User update to apply

oauthID	string
name required	string
status	string Default: "active" Enum: "active" "inactive" If inactive the user is inactive.
role	string Enum: "owner" "member"
org_id	string

Responses

Request samples

Payload

Content type

application/json

{"oauthID": "string",
"name": "string",
"status": "active",
"role": "owner",
"org_id": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Delete a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID

required

string

The ID of the user to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Ping

Checks the status of InfluxDB instance and version of InfluxDB.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Responses

Checks the status of InfluxDB instance and version of InfluxDB.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Responses

Routes

List all top level routes

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"authorizations": "http://example.com",
"buckets": "http://example.com",
"dashboards": "http://example.com",
"external": {"statusFeed": "http://example.com"
},
"variables": "http://example.com",
"me": "http://example.com",
"flags": "http://example.com",
"orgs": "http://example.com",
"query": {"self": "http://example.com",
"ast": "http://example.com",
"analyze": "http://example.com",
"suggestions": "http://example.com"
},
"setup": "http://example.com",
"signin": "http://example.com",
"signout": "http://example.com",
"sources": "http://example.com",
"system": {"metrics": "http://example.com",
"debug": "http://example.com",
"health": "http://example.com"
},
"tasks": "http://example.com",
"telegrafs": "http://example.com",
"users": "http://example.com",
"write": "http://example.com"
}

Authorizations

Create and manage API tokens. An authorization associates a list of permissions to an organization and provides a token for API access. To assign a token to a specific user, scope the authorization to the user ID.

List all authorizations

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

userID	string Only show authorizations that belong to a user ID.
user	string Only show authorizations that belong to a user name.
orgID	string Only show authorizations that belong to an organization ID.
org	string Only show authorizations that belong to a organization name.
token	string Find a token by value.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"authorizations": [{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}
]
}

Create an authorization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Authorization to create

status	string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected.
description	string A description of the token.
orgID required	string ID of org that authorization is scoped to.
required	Array of objects (Permission) non-empty List of permissions for an auth. An auth must have at least one Permission.

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"description": "string",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
]
}

Response samples

201
400
default

Content type

application/json

{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}

Retrieve an authorization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

authID

required

string

The identifier of the authorization to get.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}

Update authorization status

Update an authorization's status to active or inactive.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

authID

required

string

The identifier of the authorization to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

The updated Authorization object.

status	string Default: "active" Enum: "active" "inactive" If inactive the token is inactive and requests using the token will be rejected.
description	string A description of the token.

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"description": "string"
}

Response samples

200
default

Content type

application/json

{"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}

Delete an authorization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

authID

required

string

The identifier of the authorization to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Buckets

List all buckets

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
after	string The last resource ID from which to seek from (but not including). This is to be used instead of `offset`.
org	string The name of the organization.
orgID	string The organization ID.
name	string Only returns buckets with a specific name.
id	string Only returns buckets with a specific ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"buckets": [{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}
]
}

Create a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket to create

orgID required	string
name required	string
description	string
rp	string
required	Array of objects (RetentionRules) Rules to expire or retain data. No rules means data never expires.
schemaType	string (SchemaType) Enum: "implicit" "explicit"

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"rp": "string",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"schemaType": "implicit"
}

Response samples

201
422
default

Content type

application/json

{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Retrieve a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Update a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Bucket update to apply

name	string
description	string
	Array of objects (PatchRetentionRules) Updates to rules to expire or retain data. No rules means no updates.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
]
}

Response samples

200
default

Content type

application/json

{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Delete a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The ID of the bucket to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID required	string The bucket ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all users with member privileges for a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
bucketID required	string The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a bucket

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
bucketID required	string The bucket ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Cells

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Array ()

id	string
	object
x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>
viewID	string The reference to a view from the views API.

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
]

Response samples

201
404
default

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Create a dashboard cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Cell that will be added

name	string
x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>
usingView	string Makes a copy of the provided view.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"usingView": "string"
}

Response samples

201
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to update.
cellID required	string The ID of the cell to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"x": 0,
"y": 0,
"w": 0,
"h": 0
}

Response samples

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}

Delete a dashboard cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to delete.
cellID required	string The ID of the cell to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Retrieve the view for a cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The dashboard ID.
cellID required	string The cell ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "string"
},
"id": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Update the view for a cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to update.
cellID required	string The ID of the cell to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

name

required

string

required

LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Response samples

200
404
default

Content type

application/json

{"links": {"self": "string"
},
"id": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Checks

List all checks

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
orgID required	string Only show checks that belong to a specific organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"checks": [{"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add new check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

Check to create

name required	string
orgID required	string The ID of the organization that owns this check.
taskID	string The ID of the task associated with this check.
required	object (DashboardQuery)
status	string (TaskStatusType) Enum: "active" "inactive"
description	string An optional description of the check.
	Array of objects (Labels)
type required	string deadman PostCheck Check custom threshold deadman
timeSince	string String duration before deadman triggers.
staleTime	string String duration for time that a series is considered stale and should not trigger deadman.
reportZero	boolean If only zero values reported since time, trigger an alert
level	string (CheckStatusLevel) Enum: "UNKNOWN" "OK" "INFO" "CRIT" "WARN" The state to record if check matches a criteria.
every	string Check repetition interval.
offset	string Duration to delay after the schedule, before executing check.
	Array of objects List of tags to write to each status.
statusMessageTemplate	string The template used to generate and write a status message.

Responses

Request samples

Payload

Content type

application/json

Example

{"name": "string",
"orgID": "string",
"taskID": "string",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}

Response samples

201
default

Content type

application/json

Example

{"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}

Retrieve a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

Example

{"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}

Update a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Check update to apply

name required	string
orgID required	string The ID of the organization that owns this check.
taskID	string The ID of the task associated with this check.
required	object (DashboardQuery)
status	string (TaskStatusType) Enum: "active" "inactive"
description	string An optional description of the check.
	Array of objects (Labels)
type required	string deadman PostCheck Check custom threshold deadman
timeSince	string String duration before deadman triggers.
staleTime	string String duration for time that a series is considered stale and should not trigger deadman.
reportZero	boolean If only zero values reported since time, trigger an alert
level	string (CheckStatusLevel) Enum: "UNKNOWN" "OK" "INFO" "CRIT" "WARN" The state to record if check matches a criteria.
every	string Check repetition interval.
offset	string Duration to delay after the schedule, before executing check.
	Array of objects List of tags to write to each status.
statusMessageTemplate	string The template used to generate and write a status message.

Responses

Request samples

Payload

Content type

application/json

Example

{"name": "string",
"orgID": "string",
"taskID": "string",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}

Response samples

200
404
default

Content type

application/json

Example

{"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}

Update a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Check update to apply

name	string
description	string
status	string Enum: "active" "inactive"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"status": "active"
}

Response samples

200
404
default

Content type

application/json

Example

{"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}

Delete a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete label from a check

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID required	string The check ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Retrieve a check query

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

checkID

required

string

The check ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
400
404
default

Content type

application/json

{"flux": "string"
}

DBRPs

List database retention policy mappings

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

orgID	string Specifies the organization ID to filter on
org	string Specifies the organization name to filter on
id	string Specifies the mapping ID to filter on
bucketID	string Specifies the bucket ID to filter on
default	boolean Specifies filtering on default
db	string Specifies the database to filter on
rp	string Specifies the retention policy to filter on

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
400
default

Content type

application/json

{"content": [{"id": "string",
"orgID": "string",
"bucketID": "string",
"database": "string",
"retention_policy": "string",
"default": true,
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}
]
}

Add a database retention policy mapping

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

The database retention policy mapping to add

orgID	string the organization ID that owns this mapping.
org	string the organization that owns this mapping.
bucketID required	string the bucket ID used as target for the translation.
database required	string InfluxDB v1 database
retention_policy required	string InfluxDB v1 retention policy
default	boolean Specify if this mapping represents the default retention policy for the database specificed.

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"org": "string",
"bucketID": "string",
"database": "string",
"retention_policy": "string",
"default": true
}

Response samples

201
400
default

Content type

application/json

{"id": "string",
"orgID": "string",
"bucketID": "string",
"database": "string",
"retention_policy": "string",
"default": true,
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Retrieve a database retention policy mapping

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dbrpID

required

string

The database retention policy mapping ID

query Parameters

orgID	string Specifies the organization ID of the mapping
org	string Specifies the organization name of the mapping

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
400
default

Content type

application/json

{"content": {"id": "string",
"orgID": "string",
"bucketID": "string",
"database": "string",
"retention_policy": "string",
"default": true,
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}
}

Update a database retention policy mapping

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dbrpID

required

string

The database retention policy mapping.

query Parameters

orgID	string Specifies the organization ID of the mapping
org	string Specifies the organization name of the mapping

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Database retention policy update to apply

retention_policy	string InfluxDB v1 retention policy
default	boolean

Responses

Request samples

Payload

Content type

application/json

{"retention_policy": "string",
"default": true
}

Response samples

200
400
404
default

Content type

application/json

{"content": {"id": "string",
"orgID": "string",
"bucketID": "string",
"database": "string",
"retention_policy": "string",
"default": true,
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}
}

Delete a database retention policy

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dbrpID

required

string

The database retention policy mapping

query Parameters

orgID	string Specifies the organization ID of the mapping
org	string Specifies the organization name of the mapping

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

400
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Dashboards

Retrieve a Dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

query Parameters

include

string

Value: "properties"

Includes the cell view properties in the response if set to properties

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

Example

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Update a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Patching of a dashboard

name	string optional, when provided will replace the name
description	string optional, when provided will replace the description
	object (CellWithViewProperties)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"cells": {"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}
}

Response samples

200
404
default

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Delete a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Replace cells in a dashboard

Replaces all cells in a dashboard. This is used primarily to update the positional information of all cells.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Array ()

id	string
	object
x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>
viewID	string The reference to a view from the views API.

Responses

Request samples

Payload

Content type

application/json

[{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
]

Response samples

201
404
default

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Create a dashboard cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The ID of the dashboard to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Cell that will be added

name	string
x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>
usingView	string Makes a copy of the provided view.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"usingView": "string"
}

Response samples

201
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}

Update the non-positional information related to a cell

Updates the non positional information related to a cell. Updates to a single cell's positional data could cause grid conflicts.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to update.
cellID required	string The ID of the cell to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

x	integer <int32>
y	integer <int32>
w	integer <int32>
h	integer <int32>

Responses

Request samples

Payload

Content type

application/json

{"x": 0,
"y": 0,
"w": 0,
"h": 0
}

Response samples

200
404
default

Content type

application/json

{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}

Delete a dashboard cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to delete.
cellID required	string The ID of the cell to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Retrieve the view for a cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The dashboard ID.
cellID required	string The cell ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "string"
},
"id": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Update the view for a cell

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The ID of the dashboard to update.
cellID required	string The ID of the cell to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

name

required

string

required

LinePlusSingleStatProperties (object) or XYViewProperties (object) or SingleStatViewProperties (object) or HistogramViewProperties (object) or GaugeViewProperties (object) or TableViewProperties (object) or SimpleTableViewProperties (object) or MarkdownViewProperties (object) or CheckViewProperties (object) or ScatterViewProperties (object) or HeatmapViewProperties (object) or MosaicViewProperties (object) or BandViewProperties (object) or GeoViewProperties (object) (ViewProperties)

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

Response samples

200
404
default

Content type

application/json

{"links": {"self": "string"
},
"id": "string",
"name": "string",
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}

List all labels for a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID required	string The dashboard ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all dashboard members

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
dashboardID required	string The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all dashboard owners

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

dashboardID

required

string

The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
dashboardID required	string The dashboard ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Create a dashboard

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Dashboard to create

orgID required	string The ID of the organization that owns the dashboard.
name required	string The user-facing name of the dashboard.
description	string The user-facing description of the dashboard.

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string"
}

Response samples

201
default

Content type

application/json

Example

{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

List all dashboards

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
descending	boolean Default: false
limit	integer [ -1 .. 100 ] Default: 20 The non-zero number of dashboards to return
owner	string A user identifier. Returns only dashboards where this user has the `owner` role.
sortBy	string Enum: "ID" "CreatedAt" "UpdatedAt" The column to sort by.
id	Array of strings A list of dashboard identifiers. Returns only the listed dashboards. If both `id` and `owner` are specified, only `id` is used.
orgID	string The identifier of the organization.
org	string The name of the organization.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"dashboards": [{"orgID": "string",
"name": "string",
"description": "string",
"links": {"self": "/api/v2/dashboards/1",
"cells": "/api/v2/dashboards/1/cells",
"owners": "/api/v2/dashboards/1/owners",
"members": "/api/v2/dashboards/1/members",
"labels": "/api/v2/dashboards/1/labels",
"org": "/api/v2/labels/1"
},
"id": "string",
"meta": {"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"cells": [{"id": "string",
"links": {"self": "string",
"view": "string"
},
"x": 0,
"y": 0,
"w": 0,
"h": 0,
"viewID": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}
]
}

Delete

Delete data

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org	string Specifies the organization to delete data from.
bucket	string Specifies the bucket to delete data from.
orgID	string Specifies the organization ID of the resource.
bucketID	string Specifies the bucket ID to delete data from.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Deletes data from an InfluxDB bucket.

start required	string <date-time> RFC3339Nano
stop required	string <date-time> RFC3339Nano
predicate	string InfluxQL-like delete statement

Responses

Request samples

Payload

Content type

application/json

{"start": "2019-08-24T14:15:22Z",
"stop": "2019-08-24T14:15:22Z",
"predicate": "tag1=\"value1\" and (tag2=\"value2\" and tag3!=\"value3\")"
}

Response samples

400
403
404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

DemoDataBuckets

List of Demo Data Buckets

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"buckets": [{"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "demodata",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}
]
}

List of Demo Data Buckets

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

bucket id

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List of Demo Data Buckets

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

bucketID

required

string

bucket id

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Labels

Create a label

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

Label to create

orgID required	string
name required	string
	object Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value.

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

List all labels

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

orgID

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Retrieve a label

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

labelID

required

string

The ID of the label to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Update a label

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

labelID

required

string

The ID of the label to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label update

name	string
	object Key/Value pairs associated with this label. Keys can be removed by sending an update with an empty value.

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}

Response samples

200
404
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

labelID

required

string

The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Limits

Retrieve limits for an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The identifier of the organization.

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"limits": {"orgID": "string",
"rate": {"readKBs": 0,
"concurrentReadRequests": 0,
"writeKBs": 0,
"concurrentWriteRequests": 0,
"cardinality": 0,
"concurrentDeleteRequests": 0,
"deleteRequestsPerSecond": 0
},
"bucket": {"maxBuckets": 0,
"maxRetentionDuration": 0
},
"task": {"maxTasks": 0
},
"dashboard": {"maxDashboards": 0
},
"check": {"maxChecks": 0
},
"notificationRule": {"maxNotifications": 0,
"blockedNotificationRules": "http,pagerduty"
},
"notificationEndpoint": {"blockedNotificationEndpoints": "http,pagerduty"
},
"features": {"allowDelete": true
}
}
}

NotificationEndpoints

List all notification endpoints

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
orgID required	string Only show notification endpoints that belong to specific organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"notificationEndpoints": [{"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

Notification endpoint to create

id	string
orgID	string
userID	string
description	string An optional description of the notification endpoint.
name required	string
status	string Default: "active" Enum: "active" "inactive" The status of the endpoint.
	Array of objects (Labels)
type required	string (NotificationEndpointType) slack PostNotificationEndpoint NotificationEndpoint slack pagerduty http telegram
url	string Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`.
token	string Specifies the API token string. Specify either `URL` or `Token`.

Responses

Request samples

Payload

Content type

application/json

Example

{"id": "string",
"orgID": "string",
"userID": "string",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"type": "slack",
"url": "string",
"token": "string"
}

Response samples

201
default

Content type

application/json

Example

{"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
}

Retrieve a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID

required

string

The notification endpoint ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

Example

{"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
}

Update a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID

required

string

The notification endpoint ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

A new notification endpoint to replace the existing endpoint with

id	string
orgID	string
userID	string
description	string An optional description of the notification endpoint.
name required	string
status	string Default: "active" Enum: "active" "inactive" The status of the endpoint.
	Array of objects (Labels)
type required	string (NotificationEndpointType) slack PostNotificationEndpoint NotificationEndpoint slack pagerduty http telegram
url	string Specifies the URL of the Slack endpoint. Specify either `URL` or `Token`.
token	string Specifies the API token string. Specify either `URL` or `Token`.

Responses

Request samples

Payload

Content type

application/json

Example

{"id": "string",
"orgID": "string",
"userID": "string",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"type": "slack",
"url": "string",
"token": "string"
}

Response samples

200
404
default

Content type

application/json

Example

{"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
}

Update a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID

required

string

The notification endpoint ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Check update to apply

name	string
description	string
status	string Enum: "active" "inactive"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"status": "active"
}

Response samples

200
404
default

Content type

application/json

Example

{"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
}

Delete a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID

required

string

The notification endpoint ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID

required

string

The notification endpoint ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID

required

string

The notification endpoint ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a notification endpoint

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

endpointID required	string The notification endpoint ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

NotificationRules

List all notification rules

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
orgID required	string Only show notification rules that belong to a specific organization ID.
checkID	string Only show notifications that belong to the specific check ID.
tag	string^[a-zA-Z0-9_]+:[a-zA-Z0-9_]+$ Example: tag=env:prod Only return notification rules that "would match" statuses which contain the tag key value pairs provided.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"notificationRules": [{"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"id": "string",
"endpointID": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationRules/1",
"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query"
},
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

Notification rule to create

endpointID required	string
orgID required	string The ID of the organization that owns this notification rule.
taskID	string The ID of the task associated with this notification rule.
status required	string (TaskStatusType) Enum: "active" "inactive"
name required	string Human-readable name describing the notification rule.
sleepUntil	string
every	string The notification repetition interval.
offset	string Duration to delay after the schedule, before executing check.
runbookLink	string
limitEvery	integer Don't notify me more than times every seconds. If set, limit cannot be empty.
limit	integer Don't notify me more than times every seconds. If set, limitEvery cannot be empty.
	Array of objects (TagRule) List of tag rules the notification rule attempts to match.
description	string An optional description of the notification rule.
required	Array of objects (StatusRule) non-empty List of status rules the notification rule attempts to match.
	Array of objects (Labels)
type required	string slack PostNotificationRule NotificationRule telegram http pagerduty smtp slack
channel	string
messageTemplate required	string

Responses

Request samples

Payload

Content type

application/json

Example

{"endpointID": "string",
"orgID": "string",
"taskID": "string",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}

Response samples

201
default

Content type

application/json

Example

{"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"id": "string",
"endpointID": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationRules/1",
"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query"
},
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}

Retrieve a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

Example

{"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"id": "string",
"endpointID": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationRules/1",
"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query"
},
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}

Update a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Notification rule update to apply

endpointID required	string
orgID required	string The ID of the organization that owns this notification rule.
taskID	string The ID of the task associated with this notification rule.
status required	string (TaskStatusType) Enum: "active" "inactive"
name required	string Human-readable name describing the notification rule.
sleepUntil	string
every	string The notification repetition interval.
offset	string Duration to delay after the schedule, before executing check.
runbookLink	string
limitEvery	integer Don't notify me more than times every seconds. If set, limit cannot be empty.
limit	integer Don't notify me more than times every seconds. If set, limitEvery cannot be empty.
	Array of objects (TagRule) List of tag rules the notification rule attempts to match.
description	string An optional description of the notification rule.
required	Array of objects (StatusRule) non-empty List of status rules the notification rule attempts to match.
	Array of objects (Labels)
type required	string slack PostNotificationRule NotificationRule telegram http pagerduty smtp slack
channel	string
messageTemplate required	string

Responses

Request samples

Payload

Content type

application/json

Example

{"endpointID": "string",
"orgID": "string",
"taskID": "string",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}

Response samples

200
404
default

Content type

application/json

Example

{"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"id": "string",
"endpointID": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationRules/1",
"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query"
},
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}

Update a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Notification rule update to apply

name	string
description	string
status	string Enum: "active" "inactive"

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"status": "active"
}

Response samples

200
404
default

Content type

application/json

Example

{"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"id": "string",
"endpointID": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active",
"name": "string",
"sleepUntil": "string",
"every": "string",
"offset": "string",
"runbookLink": "string",
"limitEvery": 0,
"limit": 0,
"tagRules": [{"key": "string",
"value": "string",
"operator": "equal"
}
],
"description": "string",
"statusRules": [{"currentLevel": "UNKNOWN",
"previousLevel": "UNKNOWN",
"count": 0,
"period": "string"
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationRules/1",
"labels": "/api/v2/notificationRules/1/labels",
"members": "/api/v2/notificationRules/1/members",
"owners": "/api/v2/notificationRules/1/owners",
"query": "/api/v2/notificationRules/1/query"
},
"type": "slack",
"channel": "string",
"messageTemplate": "string"
}

Delete a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete label from a notification rule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID required	string The notification rule ID.
labelID required	string The ID of the label to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Organizations

List all organizations

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

offset	integer >= 0
limit	integer [ 1 .. 100 ] Default: 20
descending	boolean Default: false
org	string Filter organizations to a specific organization name.
orgID	string Filter organizations to a specific organization ID.
userID	string Filter organizations to a specific user ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"orgs": [{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}
]
}

Create an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization to create

name required	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

201
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}

Retrieve an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The ID of the organization to get.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}

Update an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The ID of the organization to get.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Organization update to apply

name	string New name to set on the organization
description	string New description to set on the organization

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string"
}

Response samples

200
default

Content type

application/json

{"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}

Delete an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The ID of the organization to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all members of an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
orgID required	string The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
orgID required	string The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Ping

Checks the status of InfluxDB instance and version of InfluxDB.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Responses

Checks the status of InfluxDB instance and version of InfluxDB.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Responses

Query

Retrieve data, analyze queries, and get query suggestions.

Generate an Abstract Syntax Tree (AST) from a query

Analyzes flux query and generates a query specification.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Content-Type	string Value: "application/json"

Request Body schema: application/json

Analyzed Flux query to generate abstract syntax tree.

query

required

string

Flux query script to be analyzed

Responses

Request samples

Payload

Content type

application/json

{"query": "string"
}

Response samples

200
default

Content type

application/json

{"ast": {"type": "string",
"path": "string",
"package": "string",
"files": [{"type": "string",
"name": "string",
"package": {"type": "string",
"name": {"type": "string",
"name": "string"
}
},
"imports": [{"type": "string",
"as": {"type": "string",
"name": "string"
},
"path": {"type": "string",
"value": "string"
}
}
],
"body": [{"type": "string",
"text": "string"
}
]
}
]
}
}

Retrieve query suggestions

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"funcs": [{"name": "string",
"params": {"property1": "string",
"property2": "string"
}
}
]
}

Retrieve query suggestions for a branching suggestion

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

name

required

string

The name of the branching suggestion.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"name": "string",
"params": {"property1": "string",
"property2": "string"
}
}

Analyze an InfluxQL or Flux query

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Content-Type	string Value: "application/json"

Request Body schema: application/json

Flux or InfluxQL query to analyze

	object (File) Represents a source from a single file
query required	string Query script to execute.
type	string Value: "flux" The type of query. Must be "flux".
	object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)
	object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
now	string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Payload

Content type

application/json

{"extern": {"type": "string",
"name": "string",
"package": {"type": "string",
"name": {"type": "string",
"name": "string"
}
},
"imports": [{"type": "string",
"as": {"type": "string",
"name": "string"
},
"path": {"type": "string",
"value": "string"
}
}
],
"body": [{"type": "string",
"text": "string"
}
]
},
"query": "string",
"type": "flux",
"params": { },
"dialect": {"header": true,
"delimiter": ",",
"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339"
},
"now": "2019-08-24T14:15:22Z"
}

Response samples

200
default

Content type

application/json

{"errors": [{"line": 0,
"column": 0,
"character": 0,
"message": "string"
}
]
}

Query data

Retrieves data from InfluxDB buckets.

To query data, you need the following:

organization – See View organizations for instructions on viewing your organization ID.
API token – See View tokens for instructions on viewing your API token.
InfluxDB URL – See InfluxDB URLs.
Flux or InfluxQL query.

For more information and examples, see Query with the InfluxDB API.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org	string Specifies the name of the organization executing the query. Takes either the ID or Name. If both `orgID` and `org` are specified, `org` takes precedence.
orgID	string Specifies the ID of the organization executing the query. If both `orgID` and `org` are specified, `org` takes precedence.

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Accept-Encoding	string Default: identity Enum: "gzip" "identity" The Accept-Encoding request HTTP header advertises which content encoding, usually a compression algorithm, the client is able to understand.
Content-Type	string Enum: "application/json" "application/vnd.flux"

Request Body schema:
application/json
application/json
application/vnd.flux

Flux query or specification to execute

One of

	object (File) Represents a source from a single file
query required	string Query script to execute.
type	string Value: "flux" The type of query. Must be "flux".
	object Enumeration of key-value pairs that respresent parameters to be injected into query (can only specify either this field or extern and not both)
	object (Dialect) Dialect are options to change the default CSV output format; https://www.w3.org/TR/2015/REC-tabular-metadata-20151217/#dialect-descriptions
now	string <date-time> Specifies the time that should be reported as "now" in the query. Default is the server's now time.

Responses

Request samples

Payload

Content type

Example

{"extern": {"type": "string",
"name": "string",
"package": {"type": "string",
"name": {"type": "string",
"name": "string"
}
},
"imports": [{"type": "string",
"as": {"type": "string",
"name": "string"
},
"path": {"type": "string",
"value": "string"
}
}
],
"body": [{"type": "string",
"text": "string"
}
]
},
"query": "string",
"type": "flux",
"params": { },
"dialect": {"header": true,
"delimiter": ",",
"annotations": ["group"
],
"commentPrefix": "#",
"dateTimeFormat": "RFC3339"
},
"now": "2019-08-24T14:15:22Z"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Routes

List all top level routes

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"authorizations": "http://example.com",
"buckets": "http://example.com",
"dashboards": "http://example.com",
"external": {"statusFeed": "http://example.com"
},
"variables": "http://example.com",
"me": "http://example.com",
"flags": "http://example.com",
"orgs": "http://example.com",
"query": {"self": "http://example.com",
"ast": "http://example.com",
"analyze": "http://example.com",
"suggestions": "http://example.com"
},
"setup": "http://example.com",
"signin": "http://example.com",
"signout": "http://example.com",
"sources": "http://example.com",
"system": {"metrics": "http://example.com",
"debug": "http://example.com",
"health": "http://example.com"
},
"tasks": "http://example.com",
"telegrafs": "http://example.com",
"users": "http://example.com",
"write": "http://example.com"
}

Rules

Retrieve a notification rule query

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

ruleID

required

string

The notification rule ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
400
404
default

Content type

application/json

{"flux": "string"
}

Secrets

List all secret keys for an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"secrets": ["string"
],
"links": {"self": "string",
"org": "string"
}
}

Update secrets in an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Secret key value pairs to update/add

property name*

string

Responses

Request samples

Payload

Content type

application/json

{"apikey": "abc123xyz"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Delete secrets from an organization Deprecated

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Secret key to delete

secrets

Array of strings

Responses

Request samples

Payload

Content type

application/json

{"secrets": ["string"
]
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Delete a secret from an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID required	string The organization ID.
secretID required	string The secret ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Setup

Retrieve setup status

Check if setup is allowed. Returns true if no default user, organization, or bucket have been created.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200

Content type

application/json

{"allowed": true
}

Create an initial user, organization, and bucket

Post an onboarding request to create an initial user, organization, and bucket.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Source to create

username required	string
password	string
org required	string
bucket required	string
retentionPeriodHrs	integer Deprecated
retentionPeriodSeconds	integer
	object (Limit) These are org limits similar to those configured in/by quartz.

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"org": "string",
"bucket": "string",
"retentionPeriodHrs": 0,
"retentionPeriodSeconds": 0,
"limit": {"orgID": "string",
"rate": {"readKBs": 0,
"concurrentReadRequests": 0,
"writeKBs": 0,
"concurrentWriteRequests": 0,
"cardinality": 0,
"concurrentDeleteRequests": 0,
"deleteRequestsPerSecond": 0
},
"bucket": {"maxBuckets": 0,
"maxRetentionDuration": 0
},
"task": {"maxTasks": 0
},
"dashboard": {"maxDashboards": 0
},
"check": {"maxChecks": 0
},
"notificationRule": {"maxNotifications": 0,
"blockedNotificationRules": "http,pagerduty"
},
"notificationEndpoint": {"blockedNotificationEndpoints": "http,pagerduty"
},
"features": {"allowDelete": true
}
}
}

Response samples

201
default

Content type

application/json

{"user": {"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
},
"org": {"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
},
"bucket": {"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
},
"auth": {"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}
}

Create a new user, organization, and bucket

Post an onboarding request to create a new user, organization, and bucket.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

Source to create

username required	string
password	string
org required	string
bucket required	string
retentionPeriodHrs	integer Deprecated
retentionPeriodSeconds	integer
	object (Limit) These are org limits similar to those configured in/by quartz.

Responses

Request samples

Payload

Content type

application/json

{"username": "string",
"password": "string",
"org": "string",
"bucket": "string",
"retentionPeriodHrs": 0,
"retentionPeriodSeconds": 0,
"limit": {"orgID": "string",
"rate": {"readKBs": 0,
"concurrentReadRequests": 0,
"writeKBs": 0,
"concurrentWriteRequests": 0,
"cardinality": 0,
"concurrentDeleteRequests": 0,
"deleteRequestsPerSecond": 0
},
"bucket": {"maxBuckets": 0,
"maxRetentionDuration": 0
},
"task": {"maxTasks": 0
},
"dashboard": {"maxDashboards": 0
},
"check": {"maxChecks": 0
},
"notificationRule": {"maxNotifications": 0,
"blockedNotificationRules": "http,pagerduty"
},
"notificationEndpoint": {"blockedNotificationEndpoints": "http,pagerduty"
},
"features": {"allowDelete": true
}
}
}

Response samples

201
default

Content type

application/json

{"user": {"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
},
"org": {"links": {"self": "/api/v2/orgs/1",
"members": "/api/v2/orgs/1/members",
"owners": "/api/v2/orgs/1/owners",
"labels": "/api/v2/orgs/1/labels",
"secrets": "/api/v2/orgs/1/secrets",
"buckets": "/api/v2/buckets?org=myorg",
"tasks": "/api/v2/tasks?org=myorg",
"dashboards": "/api/v2/dashboards?org=myorg"
},
"id": "string",
"name": "string",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
},
"bucket": {"links": {"labels": "/api/v2/buckets/1/labels",
"members": "/api/v2/buckets/1/members",
"org": "/api/v2/orgs/2",
"owners": "/api/v2/buckets/1/owners",
"self": "/api/v2/buckets/1",
"write": "/api/v2/write?org=2&bucket=1"
},
"id": "string",
"type": "user",
"name": "string",
"description": "string",
"orgID": "string",
"rp": "string",
"schemaType": "implicit",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
],
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
},
"auth": {"status": "active",
"description": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"orgID": "string",
"permissions": [{"action": "read",
"resource": {"type": "authorizations",
"id": "string",
"name": "string",
"orgID": "string",
"org": "string"
}
}
],
"id": "string",
"token": "string",
"userID": "string",
"user": "string",
"org": "string",
"links": {"self": "/api/v2/authorizations/1",
"user": "/api/v2/users/12"
}
}
}

Signin

Create a user session.

Authenticates Basic Auth credentials for a user. If successful, creates a new UI session for the user.

Authorizations:

BasicAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

401
403
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Signout

Expire the current UI session

Expires the current UI session for the user.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

401
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Tasks

Retrieve a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}

Update a task

Update a task. This will cancel all queued runs.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task update to apply

status	string (TaskStatusType) Enum: "active" "inactive"
flux	string The Flux script to run for this task.
name	string Override the 'name' option in the flux script.
every	string Override the 'every' option in the flux script.
cron	string Override the 'cron' option in the flux script.
offset	string Override the 'offset' option in the flux script.
description	string An optional description of the task.

Responses

Request samples

Payload

Content type

application/json

{"status": "active",
"flux": "string",
"name": "string",
"every": "string",
"cron": "string",
"offset": "string",
"description": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}

Delete a task

Deletes a task and all associated records

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The ID of the task to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List runs for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The ID of the task to get runs for.

query Parameters

after	string Returns runs after a specific ID.
limit	integer [ 1 .. 500 ] Default: 100 The number of runs to return
afterTime	string <date-time> Filter runs to those scheduled after this time, RFC3339
beforeTime	string <date-time> Filter runs to those scheduled before this time, RFC3339

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"runs": [{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}
]
}

Manually start a task run, overriding the current schedule

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

scheduledFor

string <date-time> Nullable

Time used for run's "now" option, RFC3339. Default is the server's now time.

Responses

Request samples

Payload

Content type

application/json

{"scheduledFor": "2019-08-24T14:15:22Z"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}

Retrieve a single run for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
runID required	string The run ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}

Cancel a running task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
runID required	string The run ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Retry a task run

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
runID required	string The run ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json; charset=utf-8

object

Responses

Request samples

Payload

Content type

application/json; charset=utf-8

{ }

Response samples

200
default

Content type

application/json

{"id": "string",
"taskID": "string",
"status": "scheduled",
"scheduledFor": "2019-08-24T14:15:22Z",
"log": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
],
"startedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z",
"requestedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1/runs/1",
"task": "/api/v2/tasks/1",
"retry": "/api/v2/tasks/1/runs/1/retry"
}
}

Retrieve all logs for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"events": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
]
}

Retrieve all logs for a run

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string ID of task to get logs for.
runID required	string ID of run to get logs for.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"events": [{"time": "2019-08-24T14:15:22Z",
"message": "Halt and catch fire",
"runID": "string"
}
]
}

List all labels for a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID required	string The task ID.
labelID required	string The label ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all task members

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
taskID required	string The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

taskID

required

string

The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
taskID required	string The task ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all tasks

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

name	string Returns task with a specific name.
after	string Return tasks after a specified ID.
user	string Filter tasks to a specific user ID.
org	string Filter tasks to a specific organization name.
orgID	string Filter tasks to a specific organization ID.
status	string Enum: "active" "inactive" Filter tasks by a status--"inactive" or "active".
limit	integer [ -1 .. 500 ] Default: 100 The non-zero number of tasks to return
type	string Default: "" Enum: "basic" "system" Type of task, unset by default.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
},
"tasks": [{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}
]
}

Create a new task

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Task to create

orgID	string The ID of the organization that owns this Task.
org	string The name of the organization that owns this Task.
status	string (TaskStatusType) Enum: "active" "inactive"
flux required	string The Flux script to run for this task.
description	string An optional description of the task.

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"org": "string",
"status": "active",
"flux": "string",
"description": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"type": "string",
"orgID": "string",
"org": "string",
"name": "string",
"ownerID": "string",
"description": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"authorizationID": "string",
"flux": "string",
"every": "string",
"cron": "string",
"offset": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"links": {"self": "/api/v2/tasks/1",
"owners": "/api/v2/tasks/1/owners",
"members": "/api/v2/tasks/1/members",
"labels": "/api/v2/tasks/1/labels",
"runs": "/api/v2/tasks/1/runs",
"logs": "/api/v2/tasks/1/logs"
}
}

Telegrafs

List all Telegraf configurations

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

orgID

string

The organization ID the Telegraf config belongs to.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"configurations": [{"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string",
"id": "string",
"links": {"self": "/api/v2/telegrafs/1",
"lables": "/api/v2/telegrafs/1/labels",
"owners": "/api/v2/telegrafs/1/owners",
"members": "/api/v2/telegrafs/1/members"
},
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}
]
}

Create a Telegraf configuration

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Telegraf configuration to create

name	string
description	string
	object
config	string
orgID	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string"
}

Response samples

201
default

Content type

application/json

{"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string",
"id": "string",
"links": {"self": "/api/v2/telegrafs/1",
"lables": "/api/v2/telegrafs/1/labels",
"owners": "/api/v2/telegrafs/1/owners",
"members": "/api/v2/telegrafs/1/members"
},
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Retrieve a Telegraf configuration

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf configuration ID.

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Accept	string Default: application/toml Enum: "application/toml" "application/json" "application/octet-stream"

Responses

Response samples

200
default

Content type

[agent]
interval = "10s"

Update a Telegraf configuration

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Telegraf configuration update to apply

name	string
description	string
	object
config	string
orgID	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string"
}

Response samples

200
default

Content type

application/json

{"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string",
"id": "string",
"links": {"self": "/api/v2/telegrafs/1",
"lables": "/api/v2/telegrafs/1/labels",
"owners": "/api/v2/telegrafs/1/owners",
"members": "/api/v2/telegrafs/1/members"
},
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
]
}

Delete a Telegraf configuration

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf configuration ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID required	string The Telegraf config ID.
labelID required	string The label ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all users with member privileges for a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}
]
}

Add a member to a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as member

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "member"
}

Remove a member from a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the member to remove.
telegrafID required	string The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all owners of a Telegraf configuration

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf configuration ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}
]
}

Add an owner to a Telegraf configuration

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

telegrafID

required

string

The Telegraf configuration ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to add as owner

id required	string
name	string

Responses

Request samples

Payload

Content type

application/json

{"id": "string",
"name": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
},
"role": "owner"
}

Remove an owner from a Telegraf config

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID required	string The ID of the owner to remove.
telegrafID required	string The Telegraf config ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Templates

List all templates

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org	string Specifies the name of the organization of the template.
orgID	string Specifies the organization ID of the template.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"documents": [{"id": "string",
"meta": {"name": "string",
"type": "string",
"templateID": "string",
"description": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/documents/templates/1"
}
}
]
}

Create a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Template that will be created

required	object (DocumentMeta)
content required	object
org	string The organization Name. Specify either `orgID` or `org`.
orgID	string The organization Name. Specify either `orgID` or `org`.
labels	Array of strings An array of label IDs to be added as labels to the document.

Responses

Request samples

Payload

Content type

application/json

{"meta": {"name": "string",
"type": "string",
"templateID": "string",
"description": "string",
"version": "string"
},
"content": { },
"org": "string",
"orgID": "string",
"labels": ["string"
]
}

Response samples

201
default

Content type

application/json

{"id": "string",
"meta": {"name": "string",
"type": "string",
"templateID": "string",
"description": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"content": { },
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/documents/templates/1"
}
}

Retrieve a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

templateID

required

string

The template ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"meta": {"name": "string",
"type": "string",
"templateID": "string",
"description": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"content": { },
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/documents/templates/1"
}
}

Update a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

templateID

required

string

The template ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Template that will be updated

	object (DocumentMeta)
content	object

Responses

Request samples

Payload

Content type

application/json

{"meta": {"name": "string",
"type": "string",
"templateID": "string",
"description": "string",
"version": "string"
},
"content": { }
}

Response samples

200
default

Content type

application/json

{"id": "string",
"meta": {"name": "string",
"type": "string",
"templateID": "string",
"description": "string",
"version": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"content": { },
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/documents/templates/1"
}
}

Delete a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

templateID

required

string

The template ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all labels for a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

templateID

required

string

The template ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

templateID

required

string

The template ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

templateID required	string The template ID.
labelID required	string The label ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List installed templates

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

orgID required	string The organization ID of the stacks
name	string A collection of names to filter the list by.
stackID	string A collection of stackIDs to filter the list by.

Responses

Response samples

200
default

Content type

application/json

{"stacks": [{"id": "string",
"orgID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"events": [{"eventType": "string",
"name": "string",
"description": "string",
"sources": ["string"
],
"resources": [{"apiVersion": "string",
"resourceID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"links": {"self": "string"
}
}
],
"urls": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}
]
}

Create a new stack

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

The stack to create.

orgID	string
name	string
description	string
urls	Array of strings

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"urls": ["string"
]
}

Response samples

201
default

Content type

application/json

{"id": "string",
"orgID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"events": [{"eventType": "string",
"name": "string",
"description": "string",
"sources": ["string"
],
"resources": [{"apiVersion": "string",
"resourceID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"links": {"self": "string"
}
}
],
"urls": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Retrieve a stack

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

stack_id

required

string

The identifier of the stack.

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"orgID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"events": [{"eventType": "string",
"name": "string",
"description": "string",
"sources": ["string"
],
"resources": [{"apiVersion": "string",
"resourceID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"links": {"self": "string"
}
}
],
"urls": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Update a stack

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

stack_id

required

string

The identifier of the stack.

Request Body schema: application/json

The stack to update.

name	string Nullable
description	string Nullable
templateURLs	Array of strings Nullable
	Array of objects

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"description": "string",
"templateURLs": ["string"
],
"additionalResources": [{"resourceID": "string",
"kind": "string",
"templateMetaName": "string"
}
]
}

Response samples

200
default

Content type

application/json

{"id": "string",
"orgID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"events": [{"eventType": "string",
"name": "string",
"description": "string",
"sources": ["string"
],
"resources": [{"apiVersion": "string",
"resourceID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"links": {"self": "string"
}
}
],
"urls": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Delete a stack and associated resources

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

stack_id

required

string

The identifier of the stack.

query Parameters

orgID

required

string

The identifier of the organization.

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Uninstall a stack

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

stack_id

required

string

The identifier of the stack.

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"orgID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"events": [{"eventType": "string",
"name": "string",
"description": "string",
"sources": ["string"
],
"resources": [{"apiVersion": "string",
"resourceID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"associations": [{"kind": "Bucket",
"metaName": "string"
}
],
"links": {"self": "string"
}
}
],
"urls": ["string"
],
"updatedAt": "2019-08-24T14:15:22Z"
}
]
}

Apply or dry-run a template

Applies or performs a dry-run of template in an organization.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema:
application/json
application/json
application/x-jsonnet
text/yml

dryRun	boolean
orgID	string
stackID	string
	object
	Array of objects
	object
	object
	Array of objects
	Array of objects or objects

Responses

Request samples

Payload

Content type

{"dryRun": true,
"orgID": "string",
"stackID": "string",
"template": {"contentType": "string",
"sources": ["string"
],
"contents": [{"apiVersion": "string",
"kind": "Bucket",
"meta": {"name": "string"
},
"spec": { }
}
]
},
"templates": [{"contentType": "string",
"sources": ["string"
],
"contents": [{"apiVersion": "string",
"kind": "Bucket",
"meta": {"name": "string"
},
"spec": { }
}
]
}
],
"envRefs": {"property1": "string",
"property2": "string"
},
"secrets": {"property1": "string",
"property2": "string"
},
"remotes": [{"url": "string",
"contentType": "string"
}
],
"actions": [{"action": "skipKind",
"properties": {"kind": "Bucket"
}
}
]
}

Response samples

200
201
default

Content type

application/json

{"sources": ["string"
],
"stackID": "string",
"summary": {"buckets": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"description": "string",
"retentionPeriod": 0,
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"checks": [{"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string",
"kind": "Bucket",
"templateMetaName": "string",
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"dashboards": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"description": "string",
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"charts": [{"xPos": 0,
"yPos": 0,
"height": 0,
"width": 0,
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"labels": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"labelMappings": [{"status": "string",
"resourceTemplateMetaName": "string",
"resourceName": "string",
"resourceID": "string",
"resourceType": "string",
"labelTemplateMetaName": "string",
"labelName": "string",
"labelID": "string"
}
],
"missingEnvRefs": ["string"
],
"missingSecrets": ["string"
],
"notificationEndpoints": [{"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string",
"kind": "Bucket",
"templateMetaName": "string",
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"notificationRules": [{"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"description": "string",
"endpointTemplateMetaName": "string",
"endpointID": "string",
"endpointType": "string",
"every": "string",
"offset": "string",
"messageTemplate": "string",
"status": "string",
"statusRules": [{"currentLevel": "string",
"previousLevel": "string"
}
],
"tagRules": [{"key": "string",
"value": "string",
"operator": "string"
}
],
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"tasks": [{"kind": "Bucket",
"templateMetaName": "string",
"id": "string",
"name": "string",
"cron": "string",
"description": "string",
"every": "string",
"offset": "string",
"query": "string",
"status": "string",
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"telegrafConfigs": [{"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"variables": [{"kind": "Bucket",
"templateMetaName": "string",
"id": "string",
"orgID": "string",
"name": "string",
"description": "string",
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"labelAssociations": [{"id": "string",
"orgID": "string",
"kind": "Bucket",
"templateMetaName": "string",
"name": "string",
"properties": {"color": "string",
"description": "string"
},
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
],
"envReferences": [{"resourceField": "string",
"envRefKey": "string",
"value": "string",
"defaultValue": "string"
}
]
}
]
},
"diff": {"buckets": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"name": "string",
"description": "string",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
]
},
"old": {"name": "string",
"description": "string",
"retentionRules": [{"type": "expire",
"everySeconds": 86400,
"shardGroupDurationSeconds": 0
}
]
}
}
],
"checks": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
},
"old": {"id": "string",
"name": "string",
"orgID": "string",
"taskID": "string",
"ownerID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"query": {"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
},
"status": "active",
"description": "string",
"latestCompleted": "2019-08-24T14:15:22Z",
"lastRunStatus": "failed",
"lastRunError": "string",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/checks/1",
"labels": "/api/v2/checks/1/labels",
"members": "/api/v2/checks/1/members",
"owners": "/api/v2/checks/1/owners",
"query": "/api/v2/checks/1/query"
},
"type": "deadman",
"timeSince": "string",
"staleTime": "string",
"reportZero": true,
"level": "UNKNOWN",
"every": "string",
"offset": "string",
"tags": [{"key": "string",
"value": "string"
}
],
"statusMessageTemplate": "string"
}
}
],
"dashboards": [{"stateStatus": "string",
"id": "string",
"kind": "Bucket",
"templateMetaName": "string",
"new": {"name": "string",
"description": "string",
"charts": [{"xPos": 0,
"yPos": 0,
"height": 0,
"width": 0,
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}
]
},
"old": {"name": "string",
"description": "string",
"charts": [{"xPos": 0,
"yPos": 0,
"height": 0,
"width": 0,
"properties": {"timeFormat": "string",
"type": "line-plus-single-stat",
"queries": [{"text": "string",
"editMode": "builder",
"name": "string",
"builderConfig": {"buckets": ["string"
],
"tags": [{"key": "string",
"values": ["string"
],
"aggregateFunctionType": "filter"
}
],
"functions": [{"name": "string"
}
],
"aggregateWindow": {"period": "string",
"fillValues": true
}
}
}
],
"colors": [{"id": "string",
"type": "min",
"hex": "strings",
"name": "string",
"value": 0
}
],
"shape": "chronograf-v2",
"note": "string",
"showNoteWhenEmpty": true,
"axes": {"x": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
},
"y": {"bounds": ["string"
],
"label": "string",
"prefix": "string",
"suffix": "string",
"base": "",
"scale": "log"
}
},
"staticLegend": {"colorizeRows": true,
"heightRatio": 0,
"show": true,
"opacity": 0,
"orientationThreshold": 0,
"valueAxis": "string",
"widthRatio": 0
},
"xColumn": "string",
"generateXAxisTicks": ["string"
],
"xTotalTicks": 0,
"xTickStart": 0,
"xTickStep": 0,
"yColumn": "string",
"generateYAxisTicks": ["string"
],
"yTotalTicks": 0,
"yTickStart": 0,
"yTickStep": 0,
"shadeBelow": true,
"hoverDimension": "auto",
"position": "overlaid",
"prefix": "string",
"suffix": "string",
"decimalPlaces": {"isEnforced": true,
"digits": 0
},
"legendColorizeRows": true,
"legendHide": true,
"legendOpacity": 0,
"legendOrientationThreshold": 0
}
}
]
}
}
],
"labels": [{"stateStatus": "string",
"kind": "Bucket",
"id": "string",
"templateMetaName": "string",
"new": {"name": "string",
"color": "string",
"description": "string"
},
"old": {"name": "string",
"color": "string",
"description": "string"
}
}
],
"labelMappings": [{"status": "string",
"resourceType": "string",
"resourceID": "string",
"resourceTemplateMetaName": "string",
"resourceName": "string",
"labelID": "string",
"labelTemplateMetaName": "string",
"labelName": "string"
}
],
"notificationEndpoints": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
},
"old": {"id": "string",
"orgID": "string",
"userID": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"description": "string",
"name": "string",
"status": "active",
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"self": "/api/v2/notificationEndpoints/1",
"labels": "/api/v2/notificationEndpoints/1/labels",
"members": "/api/v2/notificationEndpoints/1/members",
"owners": "/api/v2/notificationEndpoints/1/owners"
},
"type": "slack",
"url": "string",
"token": "string"
}
}
],
"notificationRules": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"name": "string",
"description": "string",
"endpointName": "string",
"endpointID": "string",
"endpointType": "string",
"every": "string",
"offset": "string",
"messageTemplate": "string",
"status": "string",
"statusRules": [{"currentLevel": "string",
"previousLevel": "string"
}
],
"tagRules": [{"key": "string",
"value": "string",
"operator": "string"
}
]
},
"old": {"name": "string",
"description": "string",
"endpointName": "string",
"endpointID": "string",
"endpointType": "string",
"every": "string",
"offset": "string",
"messageTemplate": "string",
"status": "string",
"statusRules": [{"currentLevel": "string",
"previousLevel": "string"
}
],
"tagRules": [{"key": "string",
"value": "string",
"operator": "string"
}
]
}
}
],
"tasks": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"name": "string",
"cron": "string",
"description": "string",
"every": "string",
"offset": "string",
"query": "string",
"status": "string"
},
"old": {"name": "string",
"cron": "string",
"description": "string",
"every": "string",
"offset": "string",
"query": "string",
"status": "string"
}
}
],
"telegrafConfigs": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string"
},
"old": {"name": "string",
"description": "string",
"metadata": {"buckets": ["string"
]
},
"config": "string",
"orgID": "string"
}
}
],
"variables": [{"kind": "Bucket",
"stateStatus": "string",
"id": "string",
"templateMetaName": "string",
"new": {"name": "string",
"description": "string",
"args": {"type": "query",
"values": {"query": "string",
"language": "string"
}
}
},
"old": {"name": "string",
"description": "string",
"args": {"type": "query",
"values": {"query": "string",
"language": "string"
}
}
}
}
]
},
"errors": [{"kind": "Bucket",
"reason": "string",
"fields": ["string"
],
"indexes": [0
]
}
]
}

Export a new template

Authorizations:

TokenAuthBasicAuthQuerystringAuth

Request Body schema: application/json

Export resources as an InfluxDB template.

One of

stackID	string
	Array of objects
	Array of objects

Responses

Request samples

Payload

Content type

application/json

Example

{"stackID": "string",
"orgIDs": [{"orgID": "string",
"resourceFilters": {"byLabel": ["string"
],
"byResourceKind": ["Bucket"
]
}
}
],
"resources": [{"id": "string",
"kind": "Bucket",
"name": "string"
}
]
}

Response samples

200
default

Content type

[{"apiVersion": "string",
"kind": "Bucket",
"meta": {"name": "string"
},
"spec": { }
}
]

Usage

Retrieve usage for an organization

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

orgID

required

string

The identifier of the organization.

query Parameters

start required	timestamp start time
stop	timestamp stop time
raw	boolean Default: false return raw usage data

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Users

Return the feature flags for the currently authenticated user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{ }

Retrieve the currently authenticated user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Update a password

Authorizations:

BasicAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password

required

string

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Update a password

Authorizations:

BasicAuth

path Parameters

userID

required

string

The user ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

New password

password

required

string

Responses

Request samples

Payload

Content type

application/json

{"password": "string"
}

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all users

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com"
},
"users": [{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}
]
}

Create a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User to create

oauthID	string
name required	string
status	string Default: "active" Enum: "active" "inactive" If inactive the user is inactive.
role	string Enum: "owner" "member"
org_id	string

Responses

Request samples

Payload

Content type

application/json

{"oauthID": "string",
"name": "string",
"status": "active",
"role": "owner",
"org_id": "string"
}

Response samples

201
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Retrieve a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID

required

string

The user ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Update a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID

required

string

The ID of the user to update.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

User update to apply

oauthID	string
name required	string
status	string Default: "active" Enum: "active" "inactive" If inactive the user is inactive.
role	string Enum: "owner" "member"
org_id	string

Responses

Request samples

Payload

Content type

application/json

{"oauthID": "string",
"name": "string",
"status": "active",
"role": "owner",
"org_id": "string"
}

Response samples

200
default

Content type

application/json

{"id": "string",
"oauthID": "string",
"name": "string",
"status": "active",
"links": {"self": "/api/v2/users/1"
}
}

Delete a user

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

userID

required

string

The ID of the user to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Variables

List all labels for a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID

required

string

The variable ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
default

Content type

application/json

{"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Add a label to a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID

required

string

The variable ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Label to add

labelID

string

Responses

Request samples

Payload

Content type

application/json

{"labelID": "string"
}

Response samples

201
default

Content type

application/json

{"label": {"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
},
"links": {"next": "http://example.com",
"self": "http://example.com",
"prev": "http://example.com"
}
}

Delete a label from a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID required	string The variable ID.
labelID required	string The label ID to delete.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

404
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

List all variables

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org	string The name of the organization.
orgID	string The organization ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
400
default

Content type

application/json

{"variables": [{"id": "1221432",
"name": ":ok:",
"selected": ["hello"
],
"arguments": {"type": "constant",
"values": ["howdy",
"hello",
"hi",
"yo",
"oy"
]
}
},
{"id": "1221432",
"name": ":ok:",
"selected": ["c"
],
"arguments": {"type": "map",
"values": {"a": "fdjaklfdjkldsfjlkjdsa",
"b": "dfaksjfkljekfajekdljfas",
"c": "fdjksajfdkfeawfeea"
}
}
},
{"id": "1221432",
"name": ":ok:",
"selected": ["host"
],
"arguments": {"type": "query",
"query": "from(bucket: \"foo\") |> showMeasurements()",
"language": "flux"
}
}
]
}

Create a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Variable to create

orgID required	string
name required	string
description	string
selected	Array of strings
sort_order	integer
	Array of objects (Labels)
required	QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt	string <date-time>
updatedAt	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

201
default

Content type

application/json

{"links": {"self": "http://example.com",
"org": "http://example.com",
"labels": "http://example.com"
},
"id": "string",
"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Retrieve a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID

required

string

The variable ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

200
404
default

Content type

application/json

{"links": {"self": "http://example.com",
"org": "http://example.com",
"labels": "http://example.com"
},
"id": "string",
"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Delete a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID

required

string

The variable ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Responses

Response samples

default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string"
}

Update a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID

required

string

The variable ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Variable update to apply

orgID required	string
name required	string
description	string
selected	Array of strings
sort_order	integer
	Array of objects (Labels)
required	QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt	string <date-time>
updatedAt	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com",
"org": "http://example.com",
"labels": "http://example.com"
},
"id": "string",
"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Replace a variable

Authorizations:

TokenAuthBasicAuthQuerystringAuth

path Parameters

variableID

required

string

The variable ID.

header Parameters

Zap-Trace-Span

string

Example: trace_id,1,span_id,1,baggage,[object Object]

OpenTracing span context

Request Body schema: application/json

Variable to replace

orgID required	string
name required	string
description	string
selected	Array of strings
sort_order	integer
	Array of objects (Labels)
required	QueryVariableProperties (object) or ConstantVariableProperties (object) or MapVariableProperties (object) (VariableProperties)
createdAt	string <date-time>
updatedAt	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Response samples

200
default

Content type

application/json

{"links": {"self": "http://example.com",
"org": "http://example.com",
"labels": "http://example.com"
},
"id": "string",
"orgID": "string",
"name": "string",
"description": "string",
"selected": ["string"
],
"sort_order": 0,
"labels": [{"id": "string",
"orgID": "string",
"name": "string",
"properties": {"color": "ffb3b3",
"description": "this is a description"
}
}
],
"arguments": {"type": "query",
"values": {"query": "string",
"language": "string"
}
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Write

Write time series data to buckets.

Write data

Writes data to a bucket.

To write data into InfluxDB, you need the following:

organization – See View organizations for instructions on viewing your organization ID.
bucket – See View buckets for instructions on viewing your bucket ID.
API token – See View tokens for instructions on viewing your API token.
InfluxDB URL – See InfluxDB URLs.
data in line protocol format.

For more information and examples, see Write data with the InfluxDB API.

Authorizations:

TokenAuthBasicAuthQuerystringAuth

query Parameters

org required	string The parameter value specifies the destination organization for writes. The database writes all points in the batch to this organization. If you provide both `orgID` and `org` parameters, `org` takes precedence.
orgID	string The parameter value specifies the ID of the destination organization for writes. If both `orgID` and `org` are specified, `org` takes precedence.
bucket required	string The destination bucket for writes.
precision	string (WritePrecision) Enum: "ms" "s" "us" "ns" The precision for the unix timestamps within the body line-protocol.

header Parameters

Zap-Trace-Span	string Example: trace_id,1,span_id,1,baggage,[object Object] OpenTracing span context
Content-Encoding	string Default: identity Enum: "gzip" "identity" When present, the header value tells the database that compression is applied to the line protocol in the request body.
Content-Type	string Default: text/plain; charset=utf-8 Enum: "text/plain" "text/plain; charset=utf-8" "application/vnd.influx.arrow" The header value indicates the format of the data in the request body.
Content-Length	integer The header value indicates the size of the entity-body, in bytes, sent to the database. If the length is greater than the database's `max body` configuration option, the server responds with status code `413`.
Accept	string Default: application/json Value: "application/json" The header value specifies the response format.

Request Body schema: text/plain

Data in line protocol format.

string <byte>

Responses

Response samples

400
401
404
413
default

Content type

application/json

{"code": "internal error",
"message": "string",
"op": "string",
"err": "string",
"line": 0
}

Influx Cloud API Service (2.0.1)

Authentication

TokenAuth

Example

BasicAuth

Example

QuerystringAuth

Example

Authentication

TokenAuth

Example

BasicAuth

Example

QuerystringAuth

Example

Write

Write data

Authorizations:

query Parameters

header Parameters

Request Body schema: text/plain

Responses

Response samples

Query

Generate an Abstract Syntax Tree (AST) from a query

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve query suggestions

Authorizations:

header Parameters

Responses

Response samples

Retrieve query suggestions for a branching suggestion

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Analyze an InfluxQL or Flux query

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Query data

Authorizations:

query Parameters

header Parameters

Request Body schema: application/jsonapplication/jsonapplication/vnd.flux

Responses

Request samples

Response samples

Buckets

List all buckets

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Create a bucket

Authorizations:

header Parameters

Request Body schema: application/json

Responses

Request samples

Response samples

Retrieve a bucket

Authorizations:

path Parameters

header Parameters

Responses

Response samples

Update a bucket

Authorizations:

path Parameters

Request Body schema:
application/json
application/json
application/vnd.flux